getDataFromSearchQuery

The getDataFromSearchQuery() returns the DataModel from the current search query with optional measure values transformation.

const { getDataFromSearchQuery } = viz;
getDataFromSearchQuery(config?);

Parameters:

Parameter	Type	Required	Description
config	GetDataConfig	false	Configuration options for data retrieval

GetDataConfig Type:

interface GetDataConfig {
  measureValues?: {
    enabled?: boolean;
  };
}

Config Options:

Property	Type	Default	Description
measureValues.enabled	boolean	false	When true, adds measure name and measure value rows for pivot table scenarios

Returns: MuzeType (DataModel) - The Muze DataModel containing the chart data

export const DEFAULT_MN_FIELD: UnitSchema = {
    name: 'Measure names',
    type: 'dimension',
    subtype: 'categorical',
    displayName: 'Measure names',
};

export const DEFAULT_MV_FIELD: UnitSchema = {
    name: 'Measure values',
    type: 'measure',
    subtype: 'continuous',
    defAggFn: 'sum',
    displayName: 'Measure values',
};

Basic Usage

Retrieving Chart Data

// Get data without transformations
const { getDataFromSearchQuery } = viz;

const data = getDataFromSearchQuery();

// Access data properties
const schema = data.getSchema();
const rows = data.getData();

Enabling Measure Values

// Get data with measure values enabled
const { getDataFromSearchQuery } = viz;

const data = getDataFromSearchQuery({
  measureValues: {
    enabled: true
  }
});

// This adds "Measure Names" and "Measure Values" columns
const schema = data.getSchema();